home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / SCSL / sgglse.z / sgglse
Encoding:
Text File  |  2002-10-03  |  4.8 KB  |  133 lines
  1.  
  2.  
  3.  
  4. SSSSGGGGGGGGLLLLSSSSEEEE((((3333SSSS))))                                                          SSSSGGGGGGGGLLLLSSSSEEEE((((3333SSSS))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      SGGLSE - solve the linear equality-constrained least squares (LSE)
  10.      problem
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      SUBROUTINE SGGLSE( M, N, P, A, LDA, B, LDB, C, D, X, WORK, LWORK, INFO )
  14.  
  15.          INTEGER        INFO, LDA, LDB, LWORK, M, N, P
  16.  
  17.          REAL           A( LDA, * ), B( LDB, * ), C( * ), D( * ), WORK( * ),
  18.                         X( * )
  19.  
  20. IIIIMMMMPPPPLLLLEEEEMMMMEEEENNNNTTTTAAAATTTTIIIIOOOONNNN
  21.      These routines are part of the SCSL Scientific Library and can be loaded
  22.      using either the -lscs or the -lscs_mp option.  The -lscs_mp option
  23.      directs the linker to use the multi-processor version of the library.
  24.  
  25.      When linking to SCSL with -lscs or -lscs_mp, the default integer size is
  26.      4 bytes (32 bits). Another version of SCSL is available in which integers
  27.      are 8 bytes (64 bits).  This version allows the user access to larger
  28.      memory sizes and helps when porting legacy Cray codes.  It can be loaded
  29.      by using the -lscs_i8 option or the -lscs_i8_mp option. A program may use
  30.      only one of the two versions; 4-byte integer and 8-byte integer library
  31.      calls cannot be mixed.
  32.  
  33. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  34.      SGGLSE solves the linear equality-constrained least squares (LSE)
  35.      problem:
  36.              minimize || c - A*x ||_2   subject to   B*x = d
  37.  
  38.      where A is an M-by-N matrix, B is a P-by-N matrix, c is a given M-vector,
  39.      and d is a given P-vector. It is assumed that
  40.      P <= N <= M+P, and
  41.  
  42.               rank(B) = P and  rank( ( A ) ) = N.
  43.                                    ( ( B ) )
  44.  
  45.      These conditions ensure that the LSE problem has a unique solution, which
  46.      is obtained using a GRQ factorization of the matrices B and A.
  47.  
  48.  
  49. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  50.      M       (input) INTEGER
  51.              The number of rows of the matrix A.  M >= 0.
  52.  
  53.      N       (input) INTEGER
  54.              The number of columns of the matrices A and B. N >= 0.
  55.  
  56.      P       (input) INTEGER
  57.              The number of rows of the matrix B. 0 <= P <= N <= M+P.
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. SSSSGGGGGGGGLLLLSSSSEEEE((((3333SSSS))))                                                          SSSSGGGGGGGGLLLLSSSSEEEE((((3333SSSS))))
  71.  
  72.  
  73.  
  74.      A       (input/output) REAL array, dimension (LDA,N)
  75.              On entry, the M-by-N matrix A.  On exit, A is destroyed.
  76.  
  77.      LDA     (input) INTEGER
  78.              The leading dimension of the array A. LDA >= max(1,M).
  79.  
  80.      B       (input/output) REAL array, dimension (LDB,N)
  81.              On entry, the P-by-N matrix B.  On exit, B is destroyed.
  82.  
  83.      LDB     (input) INTEGER
  84.              The leading dimension of the array B. LDB >= max(1,P).
  85.  
  86.      C       (input/output) REAL array, dimension (M)
  87.              On entry, C contains the right hand side vector for the least
  88.              squares part of the LSE problem.  On exit, the residual sum of
  89.              squares for the solution is given by the sum of squares of
  90.              elements N-P+1 to M of vector C.
  91.  
  92.      D       (input/output) REAL array, dimension (P)
  93.              On entry, D contains the right hand side vector for the
  94.              constrained equation.  On exit, D is destroyed.
  95.  
  96.      X       (output) REAL array, dimension (N)
  97.              On exit, X is the solution of the LSE problem.
  98.  
  99.      WORK    (workspace/output) REAL array, dimension (LWORK)
  100.              On exit, if INFO = 0, WORK(1) returns the optimal LWORK.
  101.  
  102.      LWORK   (input) INTEGER
  103.              The dimension of the array WORK. LWORK >= max(1,M+N+P).  For
  104.              optimum performance LWORK >= P+min(M,N)+max(M,N)*NB, where NB is
  105.              an upper bound for the optimal blocksizes for SGEQRF, SGERQF,
  106.              SORMQR and SORMRQ.
  107.  
  108.              If LWORK = -1, then a workspace query is assumed; the routine
  109.              only calculates the optimal size of the WORK array, returns this
  110.              value as the first entry of the WORK array, and no error message
  111.              related to LWORK is issued by XERBLA.
  112.  
  113.      INFO    (output) INTEGER
  114.              = 0:  successful exit.
  115.              < 0:  if INFO = -i, the i-th argument had an illegal value.
  116.  
  117. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  118.      INTRO_LAPACK(3S), INTRO_SCSL(3S)
  119.  
  120.      This man page is available only online.
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.